feat: Add spoiler channel flag and functions by ToothyDev · Pull Request #3252 · Pycord-Development/pycord

ToothyDev · 2026-06-05T13:57:33Z

Summary

This adds ChannelFlags.is_spoiler_channel (following https://docs.discord.food/resources/channel#channel-flags) as well as a .spoiler property to all applicable channel types (all except category). Same goes for making it possible to create these channels via the regular channel creation methods, again with the exception of category channels. Channel editing with this flag is also functional.

Now that it's officially documented, here's the ddocs PR: discord/discord-api-docs#8465

Depends on discord/discord-api-docs#8465

Information

This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed).
This PR is not a code change (e.g. documentation, README, typehinting,
examples, ...).

Checklist

I have searched the open pull requests for duplicates.
If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.
If type: ignore comments were used, a comment is also left explaining why.
I have updated the changelog to include these changes.
AI Usage has been disclosed.
- If AI has been used, I understand fully what the code does
I have read the Contributing Guidelines

pycord-app · 2026-06-05T13:57:38Z

Thanks for opening this pull request!
Please make sure you have read the Contributing Guidelines and Code of Conduct.

This pull request can be checked-out with:

git fetch origin pull/3252/head:pr-3252
git checkout pr-3252

This pull request can be installed with:

pip install git+https://github.com/Pycord-Development/pycord@refs/pull/3252/head

Lulalaby

take a shower <3

Lulalaby

took a shower apparently

Lulalaby

Can someone request changes reminding me to add editing & creating channels with that flag
and whatever else i may have forgotten

Soheab

Needs a way for bots to create this kind of channel

This message was sponsored by toothyfernsan on discord.

ToothyDev · 2026-06-05T18:33:26Z

I tested it with all but MediaChannels since I don't have access to those anywhere, but I'd still like a second pair of testing eyes on this

ToothyDev · 2026-06-06T18:05:55Z

Also, creating a channel with this turned on isn't possible unfortunately, gotta create + edit

# Conflicts: # CHANGELOG.md

Signed-off-by: Lala Sabathil <lala@pycord.dev>

Co-authored-by: Lala Sabathil <lala@pycord.dev> Signed-off-by: ToothyDev <55001472+ToothyDev@users.noreply.github.com>

Paillat-dev · 2026-09-18T09:10:10Z

Thanks !

vmphase

Why does this PR add any kind of support for spoiler on StageChannel, while documentation explicitly says:

IS_SPOILER_CHANNEL ... Can be set on all textual guild channels and voice channels (not GUILD_STAGE).

ToothyDev · 2026-09-18T10:02:53Z

Why does this PR add any kind of support for spoiler on StageChannel, while documentation explicitly says:

IS_SPOILER_CHANNEL ... Can be set on all textual guild channels and voice channels (not GUILD_STAGE).

To stay internally consistent, because NSFW also doesn't work on stage channels, but Pycord supports it, it CAN be passed, it just has no effect. And actually, both toggles do exist (and work) in the client UI. Basically, everything works except it having an actual effect on the channel. So, while yes, it doesn't actually do anything, I still think it's worth keeping for internal consistency and because Discord might eventually make it work for stage channels (same for nsfw)

vmphase · 2026-09-18T10:11:35Z

st has no effect. And actually, both toggles do exist (and work) in the client UI. Basically, everything works except it having an actual effect on the channel. So, while yes, it doesn't actually do anything, I still think it's worth keeping for internal consistency and because Discord might eventually make it work for stage channels (same for nsfw)

I see. If the development team is fine with this, sure.

Paillat-dev · 2026-10-02T09:02:40Z

From the docs

this channel is a Spoiler Channel i.e. users must opt in to view its contents. Can be set on all textual guild channels and voice channels (not GUILD_STAGE). Can only be set if channel’s nsfw is false

Two things:

We should not support the spoiler param for stage channel if it is explicited this way that there is no support.
It says: "Can only be set if channel’s nsfw is false". Would this mean that setting spoiler to true on a nsfw channel would fail, or does it automatically flip it to false in the backend ? I assume the latter, but I am not sure we should take it for granted `

Lulalaby · 2026-10-02T09:05:20Z

the client switches it back. i think the api rejects it

ToothyDev · 2026-10-02T09:58:15Z

Either they changed the behavior or I remember wrong, but:
NSFW channel with edit(spoiler=True) does not work, you also have to explicitly pass nsfw=False
Spoiler channel with edit(nsfw=True) does work, even without passing spoiler=False

vmphase · 2026-10-04T18:23:34Z

        HTTPException
            Editing the channel failed.
        """
+        if "spoiler" in options:


The nsfw docstring says passing nsfw=True to a spoiler channel converts it to NSFW, but this block only runs when spoiler is passed. edit(nsfw=True) alone never clears is_spoiler_channel, so the documented behavior isn't implemented. Either handle nsfw=True independently of spoiler (clear the bit) or drop that sentence from the docstring.

I just tested this with the current code. Passing nsfw=True to a spoiler channel converts it, and channel.spoiler returns False as expected

So just to make sure I understand @ToothyDev, spoiler to nsfw implicitly works fine but nsfw to spoiler implicitly fails ?

Correct. I think this was a dicussion way early in the PR where catching all the specific cases was really complicated and so it was scrapped, since the API doesn't reject it, it just doesn't do anything

It seems like the only explicitly documented behavior is

Can only be set if channel's nsfw is false

for spoiler state, and nothing about the other way around. I am not sure however if we should still rely on the API for the rest.

@Lulalaby Do you have some insight maybe ?

vmphase · 2026-10-04T18:26:09Z

Will this PR ever merge? xD

Continuously fixing bugs alongside with introducing new ones.

Add spoiler channel flag and functions

b1ded01

ToothyDev added upcoming discord feature Involves a feature not yet fully released by Discord on hold labels Jun 5, 2026

github-project-automation Bot added this to Pycord Jun 5, 2026

github-project-automation Bot moved this to Todo in Pycord Jun 5, 2026

ToothyDev added the hold: testing This pull request requires further testing label Jun 5, 2026

Lulalaby requested changes Jun 5, 2026

View reviewed changes

Lulalaby approved these changes Jun 5, 2026

View reviewed changes

Lulalaby requested changes Jun 5, 2026

View reviewed changes

Soheab requested changes Jun 5, 2026

View reviewed changes

Soheab added hold: changelog This pull request is missing a changelog entry and removed hold: changelog This pull request is missing a changelog entry labels Jun 5, 2026

Add editing spoiler flag to channel editing functions

7b79faa

ToothyDev requested review from Lulalaby, Paillat-dev and Soheab June 5, 2026 18:24

ToothyDev moved this from Todo to In Progress in Pycord Jun 5, 2026

Paillat-dev added this to the 2.9.0rc1 milestone Jun 7, 2026

ToothyDev and others added 3 commits June 22, 2026 22:13

Merge branch 'master' into feat/spoiler-channels

9d09881

# Conflicts: # CHANGELOG.md

Merge branch 'master' into feat/spoiler-channels

65bfc90

Signed-off-by: Lala Sabathil <lala@pycord.dev>

fix: changelog

f426f25

Signed-off-by: Lala Sabathil <lala@pycord.dev>

github-actions Bot added the invalid This doesn't seem right label Jul 30, 2026

This comment was marked as resolved.

Sign in to view

github-actions Bot closed this Jul 30, 2026

github-actions Bot locked as spam and limited conversation to collaborators Jul 30, 2026

github-project-automation Bot moved this from In Progress to Done in Pycord Jul 30, 2026

Pycord-Development unlocked this conversation Jul 30, 2026

pullapprove4 Bot removed the PA: Maintainers pending label Sep 12, 2026

Update CHANGELOG.md

bc6656f

Co-authored-by: Lala Sabathil <lala@pycord.dev> Signed-off-by: ToothyDev <55001472+ToothyDev@users.noreply.github.com>

ToothyDev dismissed vmphase’s stale review via bc6656f September 12, 2026 16:06

ToothyDev requested a review from Lulalaby September 15, 2026 09:32

pullapprove4 Bot added PA: All Contributors pending PA: Maintainers pending labels Sep 15, 2026

Merge branch 'master' into feat/spoiler-channels

e1be8da

Paillat-dev reviewed Sep 17, 2026

View reviewed changes

Comment thread discord/channel.py Outdated

pullapprove4 Bot removed PA: All Contributors pending PA: Maintainers pending labels Sep 17, 2026

Update docstrings to use uppercase "NSFW"

9f74834

ToothyDev requested a review from Paillat-dev September 17, 2026 10:01

Paillat-dev previously approved these changes Sep 18, 2026

View reviewed changes

vmphase reviewed Sep 18, 2026

View reviewed changes

Comment thread discord/channel.py Outdated

Comment thread discord/guild.py Outdated

Comment thread discord/guild.py Outdated

Comment thread discord/guild.py Outdated

Apply change requests

61df98c

Merge branch 'master' into feat/spoiler-channels

b42aa42

Remove spoiler functionality for stage channels

a72f7e0

Apply change request

225cc81

vmphase reviewed Oct 4, 2026

View reviewed changes

ToothyDev and others added 2 commits October 4, 2026 20:59

Apply change requests

937316a

style(pre-commit): auto fixes from pre-commit.com hooks

553ba6c

vmphase approved these changes Oct 4, 2026

View reviewed changes

Uh oh!

Conversation

ToothyDev commented Jun 5, 2026 • edited by Paillat-dev Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Information

Checklist

Uh oh!

pycord-app Bot commented Jun 5, 2026

Uh oh!

Lulalaby left a comment

Choose a reason for hiding this comment

Uh oh!

Lulalaby left a comment

Choose a reason for hiding this comment

Uh oh!

Lulalaby left a comment

Choose a reason for hiding this comment

Uh oh!

Soheab left a comment

Choose a reason for hiding this comment

Uh oh!

ToothyDev commented Jun 5, 2026

Uh oh!

ToothyDev commented Jun 6, 2026

Uh oh!

This comment was marked as resolved.

Uh oh!

Paillat-dev commented Sep 18, 2026

Uh oh!

vmphase left a comment

Choose a reason for hiding this comment

Uh oh!

ToothyDev commented Sep 18, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vmphase commented Sep 18, 2026

Uh oh!

Paillat-dev commented Oct 2, 2026

Uh oh!

Lulalaby commented Oct 2, 2026

Uh oh!

ToothyDev commented Oct 2, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vmphase Oct 4, 2026

Choose a reason for hiding this comment

Uh oh!

ToothyDev Oct 4, 2026

Choose a reason for hiding this comment

Uh oh!

vmphase Oct 4, 2026

Choose a reason for hiding this comment

Uh oh!

Paillat-dev Oct 5, 2026

Choose a reason for hiding this comment

Uh oh!

ToothyDev Oct 5, 2026

Choose a reason for hiding this comment

Uh oh!

Paillat-dev Oct 5, 2026

Choose a reason for hiding this comment

Uh oh!

vmphase commented Oct 4, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ToothyDev commented Jun 5, 2026 •

edited by Paillat-dev

Loading